All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.options.CompilerOptions

Object
   |
   +----com.symantec.itools.vcafe.openapi.options.CompilerOptions

public abstract class CompilerOptions

extends Object

Use ProjectOptionSet.getCompilerOptions() to get an instance of this object.

Version:

1.0

Author:

Symantec Internet Tools Division

Since:

VCafe 3.0

See Also:

getOptionSet, getCompilerOptions

CLASSESTODOCUMENT_ANDPACKAGE

Indicates Javadoc will only document classes and members that are "public", "protected" and "package".

CLASSESTODOCUMENT_ANDPRIVATE

Indicates Javadoc will document classes and members that are "public", "protected", "package" and "private".

CLASSESTODOCUMENT_ANDPROTECTED

Indicates Javadoc will only document classes and members that are "public" and "protected" (default).

CLASSESTODOCUMENT_PUBLIC

Indicates Javadoc will only document classes and members that are "public".

MAKESETTINGS_DONT_CHECK_DEPENDENCIES_ON_IMPORTS

Indicates project build should not check import depencies.

MAKESETTINGS_GENERATE_CLASS_FOR_OUT_OF_DATE_IMPORTS

Indicates project build should check imported classes and build them as necessary.

MAKESETTINGS_WARN_ON_OUT_OF_DATE_IMPORTS

Indicates project build should warn of out-of-date imports.

com.symantec.itools.vcafe.openapi.options.CompilerOptions()

getCustomCompilerFlags()

Gets the current custom flags that will be passed to the SJ compiler.

getJavadocClassesToDocument()

Get the type of classes and members that Javadoc will document.

getMakeSettings()

Gets make (i.e.

isAlwaysProduceJavadocWhenCompiling()

Determines whether compiling the project will always run Javadoc as well.

isDisableFunctionInlining()

Determines whether the compiler will prevent the "inlining" optimization.

isGUIApplication()

Determines whether this native Windows project is a GUI or a console application.

isGenerateDebugInformation()

Determines whether the compiler will generate debug information used by the Visual Cafe debugger.

isJavadocGenerateIndex()

Determines whether Javadoc will generate a method and field index.

isJavadocGenerateTree()

Determines whether Javadoc will generate a class hierarchy.

isJavadocIncludeAuthor()

Determines whether Javadoc will include "

isJavadocIncludeImportedSystemClasses()

Determines whether Javadoc will include imported system classes.

isJavadocIncludeVersion()

Determines whether Javadoc will include "

isJavadocSplitIndex()

Determines whether Javadoc will split the index by initial letter.

isP6PentiumCodeGeneration()

Determines whether this native Windows project will gnerate P6 or P5 Pentium code.

isShowAllJavaMessages()

Determines whether the compiler will generate all possible messages.

isShowCompilerWarnings()

Determines whether the compiler will generate warning messsages.

isShowDependencies()

Determines whether the compiler will generate file dependency messages.

isShowProgressMessages()

Determines whether the compiler will generate progress messages

isUseJavaOptimizations()

Determines whether the compiler will optimize its generated code.

isUsePerformanceProfiling()

Determines whether this native Windows project will include profiling calls in the generated code.

isUseSunJavadoc()

Determines whether Sun's Javadoc compiler will be used.

isUseSunsJavaCompiler()

Determines whether Sun's java compiler will be used.

isWarnOnDeprecated()

Determines whether the compiler will generate warning messages about deprecated code.

public static final int CLASSESTODOCUMENT_ANDPACKAGE

Indicates Javadoc will only document classes and members that are "public", "protected" and "package".

See Also:

getJavadocClassesToDocument

public static final int CLASSESTODOCUMENT_ANDPRIVATE

Indicates Javadoc will document classes and members that are "public", "protected", "package" and "private".

See Also:

getJavadocClassesToDocument

public static final int CLASSESTODOCUMENT_ANDPROTECTED

Indicates Javadoc will only document classes and members that are "public" and "protected" (default).

See Also:

getJavadocClassesToDocument

public static final int CLASSESTODOCUMENT_PUBLIC

Indicates Javadoc will only document classes and members that are "public".

See Also:

getJavadocClassesToDocument

public static final int MAKESETTINGS_DONT_CHECK_DEPENDENCIES_ON_IMPORTS

Indicates project build should not check import depencies.

See Also:

getMakeSettings

public static final int MAKESETTINGS_GENERATE_CLASS_FOR_OUT_OF_DATE_IMPORTS

Indicates project build should check imported classes and build them as necessary.

See Also:

getMakeSettings

public static final int MAKESETTINGS_WARN_ON_OUT_OF_DATE_IMPORTS

Indicates project build should warn of out-of-date imports.

See Also:

getMakeSettings

public CompilerOptions()

public abstract java.lang.String getCustomCompilerFlags()

Gets the current custom flags that will be passed to the SJ compiler.

Returns:

the custom compiler flags.

public abstract int getJavadocClassesToDocument()

Get the type of classes and members that Javadoc will document. This is CLASSESTODOCUMENT_ANDPROTECTED by default.

Returns:

One of:

• CLASSESTODOCUMENT_PUBLIC - public classes/members only,
• CLASSESTODOCUMENT_ANDPROTECTED - public and protected classes/members only, or
• CLASSESTODOCUMENT_ANDPACKAGE - public, protected and package classes/members only, or
• CLASSESTODOCUMENT_ANDPRIVATE - public, protected, package and private classes/members.

public abstract int getMakeSettings()

Gets make (i.e. build) options.

Returns:

One of:

• MAKESETTINGS_DONT_CHECK_DEPENDENCIES_ON_IMPORTS - doesn't check imported classes,
• MAKESETTINGS_WARN_ON_OUT_OF_DATE_IMPORTS - warns of out-of-date imported classes, or
• MAKESETTINGS_GENERATE_CLASS_FOR_OUT_OF_DATE_IMPORTS - builds out-of-date imported classes.

public abstract boolean isAlwaysProduceJavadocWhenCompiling()

Determines whether compiling the project will always run Javadoc as well.

Returns:

true if so, false otherwise. This is false by default.

public abstract boolean isDisableFunctionInlining()

Determines whether the compiler will prevent the "inlining" optimization. Inlining means that Visual Cafe takes a method's code and imbeds it in the calling method instead of calling the method.

Inlining increases execution speed but also increases executable size.

Returns:

true if inlining is disabled, false otherwise.

public abstract boolean isGUIApplication()

Determines whether this native Windows project is a GUI or a console application. If it is a GUI application, the console window will be suprressed.

Note: this option is only valid when generating native Windows targets.

Returns:

true indicates GUI, false indicates console.

See Also:

getTargetType

public abstract boolean isGenerateDebugInformation()

Determines whether the compiler will generate debug information used by the Visual Cafe debugger.

Returns:

true if debug information is generated, false otherwise.

public abstract boolean isJavadocGenerateIndex()

Determines whether Javadoc will generate a method and field index.

Returns:

true if so, false otherwise. This is true by default.

public abstract boolean isJavadocGenerateTree()

Determines whether Javadoc will generate a class hierarchy.

Returns:

true if so, false otherwise. This is true by default.

public abstract boolean isJavadocIncludeAuthor()

Determines whether Javadoc will include "@author" paragraphs.

Returns:

true if so, false otherwise. This is true by default.

public abstract boolean isJavadocIncludeImportedSystemClasses()

Determines whether Javadoc will include imported system classes.

Returns:

true if so, false otherwise. This is false by default.

public abstract boolean isJavadocIncludeVersion()

Determines whether Javadoc will include "@version" paragraphs.

Returns:

true if so, false otherwise. This is true by default.

public abstract boolean isJavadocSplitIndex()

Determines whether Javadoc will split the index by initial letter.

Note: this option is only valid when isJavadocGenerateIndex is true.

Returns:

true if so, false otherwise. This is false by default.

public abstract boolean isP6PentiumCodeGeneration()

Determines whether this native Windows project will gnerate P6 or P5 Pentium code.

Note: this option is only valid when generating native Windows targets.

Returns:

true indicates P6 Pentium code generated, false indicates P5 Pentium code generated.

See Also:

getTargetType

public abstract boolean isShowAllJavaMessages()

Determines whether the compiler will generate all possible messages.

Returns:

true if so, false otherwise.

public abstract boolean isShowCompilerWarnings()

Determines whether the compiler will generate warning messsages.

Returns:

true if so, false otherwise.

public abstract boolean isShowDependencies()

Determines whether the compiler will generate file dependency messages.

Returns:

true if so, false otherwise.

public abstract boolean isShowProgressMessages()

Determines whether the compiler will generate progress messages

Returns:

true if so, false otherwise.

public abstract boolean isUseJavaOptimizations()

Determines whether the compiler will optimize its generated code.

Optimizing results in a smaller executable that runs faster.

Returns:

true if optimizations are on, false otherwise.

public abstract boolean isUsePerformanceProfiling()

Determines whether this native Windows project will include profiling calls in the generated code.

Note: this option is only valid when generating native Windows targets.

Returns:

true indicates profiling calls included, false indicates no profiling calls.

See Also:

getTargetType

public abstract boolean isUseSunJavadoc()

Determines whether Sun's Javadoc compiler will be used.

Returns:

true if so, false otherwise. This is false by default.

public abstract boolean isUseSunsJavaCompiler()

Determines whether Sun's java compiler will be used.

Returns:

true if so, false otherwise.

public abstract boolean isWarnOnDeprecated()

Determines whether the compiler will generate warning messages about deprecated code.

Returns:

true if so, false otherwise.

All Packages  Class Hierarchy  This Package  Previous  Next  Index